Lấy danh sách Bot

Lấy danh sách Bot đang tồn tại trong hệ thống

HTTP request

GET https://{app_id}.api.piscale.com/chat-bot/v1.0/bots

Parameter

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
ext_bot_id	string	ID của bot có dữ liệu cuối cùng	✗
prev_limit	int	Giới hạn số lượng và lấy bot có id < ext_bot_id	✗
next_limit	int	Giới hạn số lượng và lấy bot có id > ext_bot_id	✗
ext_tenant_id	string	Tenant ID	✓

Response

Ngoài những thông tin cơ bản của bot, PiScale trả về dữ liệu link.next và link.prev để tiện cho việc truy vấn phân trang.

Ví dụ

{
    "message_code": "M200",
    "message": "Success",
    "data": [
        {
            "user_id": "kw04GXRFtO:1690252859",
            "display_name": "BOT 1",
            "description": "",
            "avatar_url": "",
            "status": 1,
            "ext_tenant_id": "6872016393176737",
            "created_at": 1690252859463,
            "updated_at": 1690252859463,
            "config": {
                "webhook_url": "http://api.xyz.com/webhook",
                "receive_all_msg": 0
            },
            "token": "6872016393266763:ys3aO4xEv2WjlrNoIbHyRJQIJZEzfTIdojie",
            "ext_bot_id": "6872016393266763",
            "is_global": 2
        },
        {
            "user_id": "pq4QLm1TH9:1690253341",
            "display_name": "BOT 2",
            "description": "",
            "avatar_url": "",
            "status": 1,
            "ext_tenant_id": "6872016393176737",
            "created_at": 1690253341509,
            "updated_at": 1690253341509,
            "config": {
                "webhook_url": "http://localhost:5001/healthz/webhook",
                "receive_all_msg": 1
            },
            "token": "6872016393266764:h6y8u89NhBW3uXhkoM9Ca1EmQyhSIDKcTKXw",
            "ext_bot_id": "6872016393266764",
            "is_global": 2
        }
    ],
    "link": {
        "next": "?ext_bot_id=6872016393266764&next_limit=2&ext_tenant_id=6872016393176737",
        "prev": "?ext_bot_id=6872016393266763&prev_limit=2&ext_tenant_id=6872016393176737"
    }
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp
data[i].user_id	string	Id trong hệ thống của bạn, nếu không truyền PiScale sẽ tạo một id cho bot
data[i].display_name	string	Tên hiển thị của bot
data[i].avatar_url	string	Url ảnh đại diện của bot
data[i].description	string	Mô tả bot
data[i].ext_tenant_id	string	Tenant của bot
data[i].ext_bot_id	string	ID của bot trên hệ thống PiScale
data[i].is_global	int	Phạm vi hoạt động của bot
data[i].config.webhook_url	string	Thiết lập endpoint mà bạn muốn nhận được event
data[i].config.receive_all_msg	int	Nếu bạn muốn nhận được tất cả tin nhắn trong cuộc hội thoạt có bot thì thiết lập giá trị là 1. Mặc định PiScale sẽ đẩy dữ liệu về đầu webhook nếu phát hiện Bot được nhắc đến hoặc tin nhắn chứa command
link.next	string	Dùng để truy vấn dữ liệu trang tiếp theo
link.prev	string	Dùng để truy vấn dữ liệu trang trước đó